home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / wb / czesc_3 / reyes / reyes.doc < prev    next >
Text File  |  1994-06-20  |  13KB  |  323 lines
  1. REyes Manual
  2. ------------
  3.  
  4.  
  5.      NAME
  6.      ----    
  7.         SYS:WBStartup/REyes
  8.  
  9.      SYNOPSIS
  10.      --------
  11.         REyes     CX_POPKEY=<HotKey>
  12.                   CX_POPUP=<YES | NO>
  13.                   BLANKKEY=<HotKey>
  14.                   TIMEOUT=<1 - 3600>
  15.                   CLIENTTIMEOUT=<1 - 60>
  16.                   DISPLAY=<Display Type>
  17.                   EYES=<1 - 10>
  18.                   %CHANCE=<1 - 100>
  19.                   SPEED=<1 - 10>
  20.  
  21.  
  22.      DESCRIPTION
  23.      -----------
  24.           REyes is a screen blanker with two levels of protection, the
  25.         first of which is an animation of a collection of floating eyes.
  26.         If the CPU is to busy, REyes will disable the screen altogether,
  27.         preventing the animation from burning into the screen.
  28.  
  29.  
  30.      REQUIREMENTS
  31.      ------------
  32.  
  33.           AmigaDOS 2.04 or better and a Retina graphics card.
  34.  
  35.  
  36.      PURPOSE
  37.      -------
  38.  
  39.           REyes is a screenblanker.  The animation during blanking phase is
  40.         loosely based upon the Retina card logo, but mostly on my
  41.         (slightly) twisted imagination.
  42.  
  43.           A screen blanker's goal is to blank (disable) the screen output
  44.         in order to prevent burning images into the monitor's phosphor, but
  45.         just to disabling the screen is boring.  Instead, REyes displays a
  46.         configurable number of floating eyeballs to amuse you and to remind
  47.         you that the computer is still running.
  48.  
  49.  
  50.      STARTING
  51.      --------
  52.  
  53.           REyes is a Commodity, so it only runs under WB 2.04 and higher.
  54.         Just drop it in your WBStartup drawer so that it will load
  55.         automatically upon boot-up.  Just copy REyes and REyes.info to
  56.         SYS:WBStartup (or drag its icon to the WBStartup drawer).  It also
  57.         requires the Retina hardware and will not run if you don't have it.
  58.  
  59.           To start REyes without rebooting, just double-click on its icon.
  60.         If the Tool Types haven't been changed, a window will be displayed.
  61.         This is the "option panel" of REyes.  To see it blank the screen,
  62.         click on the "Blank" button.  To remove the option panel, click on
  63.         the "Hide" button.
  64.  
  65.           You can also start REyes from the CLI, just use the form:
  66.  
  67.                   RUN >NIL: <NIL: REyes {arguments}
  68.  
  69.              The arguments for CLI-Start are exactly the same as the
  70.         ToolTypes,  (See below)
  71.  
  72.  
  73.      ARGUMENTS
  74.      ---------
  75.  
  76.           REyes supports the standard Tool Type entries for commodities.
  77.         To set them, click on the REyes icon and select "Information" from
  78.         the Icons menu.  (Please refer to your AmigaDOS Manual for more
  79.         information on commodities and Tool Types.)
  80.  
  81.  
  82.           SUPPORTED TOOL TYPES:
  83.           ---------------------
  84.  
  85.           DONOTWAIT              When started from WBStartup, this lets WB
  86.                                  know that it shouldn't wait for REyes to
  87.                                  finish.  This tool type should >always< be
  88.                                  present.
  89.           
  90.           STARTPRI=<n>           This sets REyes' priority to "n".  "n"
  91.                                  should be a number between -120 and 120.
  92.                                  When started from WBStartup, this value
  93.                                  determines REyes priority in the
  94.                                  commodities list.  It should be a negative
  95.                                  number (i.e., low priority) so that all
  96.                                  other commodities have a chance to modify
  97.                                  the input stream before REyes sees it.
  98.  
  99.           CX_POPKEY=<HotKey>     This sets the key sequence that will open
  100.                                  REyes' option panel.  Please see below for
  101.                                  HotKey definitions.  Defaults to "shift
  102.                                  alt s".
  103.  
  104.           CX_POPUP=<YES | NO>    If this is set to "NO"  REyes will start
  105.                                  silently.  If it is set to anything else,
  106.                                  REyes will open its option panel when it
  107.                                  starts.
  108.  
  109.           BLANKKEY=<HotKey>      This defines the key sequence that will
  110.                                  instantly blank the screen.  Please see
  111.                                  below for HotKey definitions.  The default
  112.                                  blanking key is "lamiga s".
  113.  
  114.           TIMEOUT=<1 - 3600>     This sets the amount of time over which no
  115.                                  input events may occur in order for the
  116.                                  screen to blank.
  117.  
  118.           CLIENTTIMEOUT=<1 - 6>  This sets the maximum time REyes will try
  119.                                  to draw the animation.  If REyes can't
  120.                                  update the animation at least this often,
  121.                                  it will disable the screen.  This keeps
  122.                                  the eyes from burning into the monitor,
  123.                                  but it also keeps REyes from wasting CPU
  124.                                  time when another program needs it.
  125.  
  126.           EYES=<1 - 10>          The number of Eyes to float around.
  127.  
  128.           SPEED=<1-10>           The speed (10 is fastest) of the eyes'
  129.                                  movement.
  130.  
  131.           %CHANCE=<1-100>        The chance that a given eye ball will
  132.                                  start animating at any given moment. I.E.,
  133.                                  %CHANCE=1 means the eyes will change only
  134.                                  occasionally, %CHANCE=100 means they will
  135.                                  do it constantly.
  136.  
  137.           NOTE: ToolTypes are case-sensitive, so make sure your
  138.         capitalization matches that shown above.
  139.  
  140.  
  141.      DEFAULT TOOL TYPES
  142.      ------------------
  143.  
  144.           When installed, REyes has the following Tool Types:
  145.  
  146.           DONOTWAIT              # Tell WB to not wait for REyes to finish.
  147.           CX_POPUP=YES           # Display the window when starting
  148.           STARTPRI=-120          # Sets a low CX priority for starting
  149.  
  150.  
  151.      HOT KEYS
  152.      --------
  153.  
  154.           Refer to your AmigaDOS Manual ("The Extras Programs/The Commodities
  155.         Drawer") to get a valid list of the available hot keys, the following 
  156.         may be obsolete with a new Commodities.library version:
  157.  
  158.         SYNOPSIS:  [<qualifier> [<qualifier>...]] <key>
  159.  
  160.              Qualifier keywords (Press and hold one or more qualifier)
  161.  
  162.              alt                 either Alt key
  163.              ralt                right Alt key
  164.              lalt                left Alt key
  165.              shift               either Shift key
  166.              rshift              right Shift key
  167.              lshift              left Shift key
  168.              capslock            Caps Lock key
  169.              rcommand            right Amiga key
  170.              lcommand            left Amiga key
  171.              control             Control key
  172.              numericpad          Enables the use of a key on the numeric
  173.                                  keypad
  174.              rbutton             Click (and hold) the right mouse button
  175.              midbutton           Click (and hold) the middle mouse button
  176.                                  (only avail for mice with three buttons.)
  177.              leftbutton          Click (and hold) the left mouse button
  178.              newprefs            Preferences changed
  179.              diskremoved         Disk removed
  180.              diskinserted        Disk inserted
  181.  
  182.  
  183.              Keys (to be pressed and released, only ONE Key can be chosen)
  184.  
  185.              a..z, 0..9, etc.    Normal keys
  186.              f1 .. f10           Function keys
  187.              up down left right  Cursor keys
  188.              help                Help key
  189.              del                 Delete key
  190.              return              Return key
  191.              enter               Enter key (MUST be combined with
  192.                                  'numericpad'!)
  193.              backspace           Backspace key
  194.              esc                 Escape key
  195.              space               Space key
  196.              comma               Comma key
  197.              upstroke            Upstroke key
  198.  
  199.  
  200.              Examples:
  201.  
  202.                   lalt ralt enter
  203.                   ramiga f10
  204.                   alt x
  205.                   lalt numericpad enter
  206.  
  207.           NOTE: Choose your hotkeys carefully.  Commodities can change the
  208.         way standard keys operate, and if you assign "a" to blank the
  209.         screen, then the screen will blank every time you push it - even
  210.         when you're trying to type.
  211.  
  212.           If you try to use an illegal hot key combination, REyes will not
  213.         start, but will display an error message, instead.  Some examples
  214.         of illegal hot keys are:
  215.  
  216.           lalt a b               # Two keys specified
  217.           leftbutton             # No key specified
  218.           control lcommand rcommand   # Reboots the system (oops!)
  219.  
  220.      EDIT WINDOW
  221.      -----------
  222.  
  223.           Some REyes settings can be changed while REyes is executing.  To
  224.         change the settings, open the REyes option window by pressing the
  225.         CX_POPKEY sequence you defined.  Changes made in the option window
  226.         will not be saved.
  227.  
  228.           When the option panel opens, you will see some gadgets and a
  229.         scrollable list of display modes.
  230.  
  231.           TIMER:                 The value for the timeout of the blanker.
  232.                                  After this time (in seconds) the blanker
  233.                                  will display the eyes. TIMER may have a
  234.                                  value between between 1 and 3600.
  235.  
  236.           CLIENT TIMEOUT:        The time REyes gives the animation
  237.                                  routines to update the screen.  If the
  238.                                  animation routines exceed this limit, the
  239.                                  screen will be blacked out to prevent
  240.                                  burn-ins.
  241.  
  242.           %CHANCE:               The chance the eye balls will animate at
  243.                                  any given moment.
  244.  
  245.           SPEED:                 The maximum pixels per frame the eyes will
  246.                                  move.
  247.  
  248.           EYES:                  The number of floating eyes.
  249.  
  250.           HIDE:                  (click or press 'h') Closes the option
  251.                                  window, without stopping REyes.
  252.  
  253.           BLANK:                 (click or press 'b') Immediately blanks
  254.                                  the screen.
  255.  
  256.           QUIT:                  (click or press 'q') Quit.
  257.  
  258.      COMMODITIES EXCHANGE
  259.      --------------------
  260.  
  261.         With the Exchange tool, you can temporarly disable or permanently
  262.      kill REyes and other commodities.  Please refer to the AmigaDOS Manual
  263.      (Section AmigaDOS Reference and Workbench Programs) for further
  264.      information on Exchange.
  265.  
  266.      SMALL EYES
  267.      ----------
  268.  
  269.         REyes weighs in at about 64k.  If you feel that's to fat for a screen
  270.      blanker, or if you just get tired of the animations, SmallEyes is the
  271.      same program but without the animation frames.  SmallEyes is only about
  272.      18k, and is exactly the same as REyes - it just doesn't animate the 
  273.      eyes.
  274.  
  275.      COMMON PROBLEMS
  276.      ---------------
  277.  
  278.      1)   You are running a C-Compiler or a raytracer.  REyes blanks but
  279.           doesn't show the eyes, or the eyes only appear erraticly.
  280.  
  281.           If the CPU usage is high, REyes will simply blank the screen.
  282.           This keeps REyes from degrading the speed of other processes, and
  283.           it prevents the eyes from burning the monitor by getting stuck in
  284.           one place too long.
  285.  
  286.           Another time this can occur is when you're using all the Retina's
  287.           video memory for other screens.  If this happens, REyes will
  288.           first try to open a low resolution screen instead of the normal
  289.           high res one.  If >that< fails, REyes will resort to simply
  290.           blanking the screen.
  291.      
  292.      2)   REyes blanks the screen, but the eyes are all lo-res and chunky
  293.           looking. (whine whine)
  294.      
  295.           See the previous note.  If REyes can't open a high res screen, it
  296.           tries to open a low-res one.  If that fails, it just blacks out
  297.           the screen.
  298.  
  299.      3)   When a disk is inserted, REyes "unblanks".  This is normal.
  300.           Disk-replacement is detected as an input event. As all input
  301.           events disable the blanker, this one does as well.
  302.  
  303.      4)   REyes displays the window though the Tool Type CX_POPUP is set to
  304.           'NO'.
  305.  
  306.           This happens when REyes is started but another copy is already
  307.           running.
  308.  
  309.      CREDITS
  310.      -------
  311.  
  312.           Much of the code style and technique of this blanker was inspired
  313.         by the PD blanker ASwarmIII by Jake Rose.  He did a good job
  314.         showing me how it's done.
  315.  
  316.      AUTHOR
  317.      ------
  318.      
  319.           Michael Heinz
  320.       William Henry Apts, #OAK-123
  321.       Malvern, PA 19355
  322.       (610)-251-3361
  323.